'\" t
.\"     Title: bugle-showstats
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: October 2007
.\"    Manual: Bugle user manual
.\"    Source: BUGLE 0.0.20150628
.\"  Language: English
.\"
.TH "BUGLE\-SHOWSTATS" "7" "October 2007" "BUGLE 0.0.20150628" "Bugle user manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bugle-showstats \- render statistics over the display
.SH "SYNOPSIS"
.sp
.nf
filterset showstats
{
    show "\fIstatistic1\fR"
    show "\fIstatistic2\fR"
    graph "\fIstatistic3\fR"
}
.fi
.SH "DESCRIPTION"
.PP
The
showstats
filter\-set display statistics gathered by other filter\-sets over the rendered display\&. Statistics can be displayed either as text or as graphs\&.
.SH "OPTIONS"
.PP
\fBshow\fR
.RS 4
Specifies a statistic to display as text\&. The name must match an entry in
~/\&.bugle/statistics\&.
.RE
.PP
\fBgraph\fR
.RS 4
This is like the
\fBshow\fR
option above, but displays a graph rather than text\&.
.RE
.PP
\fBtime\fR
.RS 4
The interval (in seconds) between updating the statistics\&. The default is one second\&.
.RE
.PP
\fBkey_accumulate\fR
.RS 4
By default, statistics are averaged over the time interval specified above, making them approximately instantaneous rates\&. Pressing this key will cause the display to instead show the average from the time the key was pressed until the current moment\&.
.RE
.PP
\fBkey_unaccumulate\fR
.RS 4
This key cancels the effect of
\fBkey_accumulate\fR\&.
.RE
.SH "FILES"
.PP
~/\&.bugle/statistics
.RS 4
Formulae and metadata for statistics
.RE
.SH "ENVIRONMENT"
.PP
\fBBUGLE_STATISTICS\fR
.RS 4
If set, defines the location of the statistics file, overriding the default above\&.
.RE
.SH "AUTHOR"
.PP
bugle
is written and maintained by
Bruce Merry\&.
.SH "SEE ALSO"
.PP
\fBbugle\fR(3),
\fBbugle-statistics\fR(5)
